\hypertarget{group__uart__api}{
\section{Uart\_\-api}
\label{group__uart__api}\index{Uart\_\-api@{Uart\_\-api}}
}
\subsection*{Defines}
\begin{DoxyCompactItemize}
\item 
\#define {\bfseries UART\_\-CLK\_\-DIVIDER}
\end{DoxyCompactItemize}
\subsection*{Functions}
\begin{DoxyCompactItemize}
\item 
void \hyperlink{group__uart__api_ga60b51a3d202057e4d131fadb9659d467}{UARTParityModeSet} (unsigned long ulBase, unsigned long ulParity)
\item 
unsigned long \hyperlink{group__uart__api_ga3d14f283b4007a333509e3748537709f}{UARTParityModeGet} (unsigned long ulBase)
\item 
void \hyperlink{group__uart__api_ga03ac261faad90a93a6a728b450412814}{UARTFIFOLevelSet} (unsigned long ulBase, unsigned long ulTxLevel, unsigned long ulRxLevel)
\item 
void \hyperlink{group__uart__api_ga30e3f5cfeb0006b664a7af4a91c41713}{UARTFIFOLevelGet} (unsigned long ulBase, unsigned long $\ast$pulTxLevel, unsigned long $\ast$pulRxLevel)
\item 
void \hyperlink{group__uart__api_ga174a10f735a7e11645e17c893b1f10a9}{UARTConfigSetExpClk} (unsigned long ulBase, unsigned long ulUARTClk, unsigned long ulBaud, unsigned long ulConfig)
\item 
void \hyperlink{group__uart__api_ga8a47d0131c5d06962e572e2c764343e5}{UARTConfigGetExpClk} (unsigned long ulBase, unsigned long ulUARTClk, unsigned long $\ast$pulBaud, unsigned long $\ast$pulConfig)
\item 
void \hyperlink{group__uart__api_gacc1104922d17e36b8e54fc10234f450a}{UARTEnable} (unsigned long ulBase)
\item 
void \hyperlink{group__uart__api_gaa0d8f81b2c9ef3e8a7fbc4f5128f3fb0}{UARTDisable} (unsigned long ulBase)
\item 
void \hyperlink{group__uart__api_ga7ff285fcffe190e94580ed2c3d88d453}{UARTFIFOEnable} (unsigned long ulBase)
\item 
void \hyperlink{group__uart__api_ga43f0540451cd15a76249580db4e8c49a}{UARTFIFODisable} (unsigned long ulBase)
\item 
void \hyperlink{group__uart__api_ga11b801327a12971dd45ee4a9f4d63a48}{UARTEnableSIR} (unsigned long ulBase, tBoolean bLowPower)
\item 
void \hyperlink{group__uart__api_gab8c5b1ec5a1837d13961077c130ff111}{UARTDisableSIR} (unsigned long ulBase)
\item 
void \hyperlink{group__uart__api_ga6da68929f43a33de8cdf3f3292659256}{UARTSmartCardEnable} (unsigned long ulBase)
\item 
void \hyperlink{group__uart__api_ga8f25858c44bfe9110a4e41f9cc645cd5}{UARTSmartCardDisable} (unsigned long ulBase)
\item 
void \hyperlink{group__uart__api_ga11748f2c339c4ac76081dc4579ce48fb}{UARTModemControlSet} (unsigned long ulBase, unsigned long ulControl)
\item 
void \hyperlink{group__uart__api_ga18a48c2588dc18c185d2bfe56efa38a4}{UARTModemControlClear} (unsigned long ulBase, unsigned long ulControl)
\item 
unsigned long \hyperlink{group__uart__api_gaf0fc13d9eb0862f6550fee0d80b7c928}{UARTModemControlGet} (unsigned long ulBase)
\item 
unsigned long \hyperlink{group__uart__api_ga65e88c92f875fe09497649b0b64ed38b}{UARTModemStatusGet} (unsigned long ulBase)
\item 
void \hyperlink{group__uart__api_ga6eeabcb27e83ab4c37df473bdfd4c9ea}{UARTFlowControlSet} (unsigned long ulBase, unsigned long ulMode)
\item 
unsigned long \hyperlink{group__uart__api_ga206a270d0b9b7eb0e73bf054959e0d97}{UARTFlowControlGet} (unsigned long ulBase)
\item 
void \hyperlink{group__uart__api_ga12d6d0b529011cd29edd0142f90108e7}{UARTTxIntModeSet} (unsigned long ulBase, unsigned long ulMode)
\item 
unsigned long \hyperlink{group__uart__api_ga76dd86207a90f186fe78684db444a6cf}{UARTTxIntModeGet} (unsigned long ulBase)
\item 
tBoolean \hyperlink{group__uart__api_ga7044fe20068144878fd2522e7e9a5906}{UARTCharsAvail} (unsigned long ulBase)
\item 
tBoolean \hyperlink{group__uart__api_gaa08e306b9a49f638038d968392ff0cc1}{UARTSpaceAvail} (unsigned long ulBase)
\item 
long \hyperlink{group__uart__api_gabb43dee3bc04bf1b96a2937659c69240}{UARTCharGetNonBlocking} (unsigned long ulBase)
\item 
long \hyperlink{group__uart__api_ga1a69bc9d77f005406b49a3f7f12ae95c}{UARTCharGet} (unsigned long ulBase)
\item 
tBoolean \hyperlink{group__uart__api_gaef2dd93e39148080c87880b8da14adc3}{UARTCharPutNonBlocking} (unsigned long ulBase, unsigned char ucData)
\item 
void \hyperlink{group__uart__api_ga264bf4d7b309ecb7398a5b6a735e05a6}{UARTCharPut} (unsigned long ulBase, unsigned char ucData)
\item 
void \hyperlink{group__uart__api_gacacb3f55eee1aa3b4f77359715014d3f}{UARTBreakCtl} (unsigned long ulBase, tBoolean bBreakState)
\item 
tBoolean \hyperlink{group__uart__api_gafc7dd7a073f54c94d0edd353b6bea9e6}{UARTBusy} (unsigned long ulBase)
\item 
void \hyperlink{group__uart__api_ga3b0a30072c49b1414d6c0a8295e29d00}{UARTIntRegister} (unsigned long ulBase, void($\ast$pfnHandler)(void))
\item 
void \hyperlink{group__uart__api_ga73bc2d5b32b3bfb4eb0987b55efaaf45}{UARTIntUnregister} (unsigned long ulBase)
\item 
void \hyperlink{group__uart__api_gae2e0dbcdb433d714f45934c531d38a2a}{UARTIntEnable} (unsigned long ulBase, unsigned long ulIntFlags)
\item 
void \hyperlink{group__uart__api_ga9b5e85acf8ff0ce74bf8b43686c306a8}{UARTIntDisable} (unsigned long ulBase, unsigned long ulIntFlags)
\item 
unsigned long \hyperlink{group__uart__api_ga7c827b68812b2ced7f127dcd8129d955}{UARTIntStatus} (unsigned long ulBase, tBoolean bMasked)
\item 
void \hyperlink{group__uart__api_ga8fa3c50d42d232749f3574e099f7031b}{UARTIntClear} (unsigned long ulBase, unsigned long ulIntFlags)
\item 
void \hyperlink{group__uart__api_gabdbf6470ce1c96eaaa12ca41d58aabfb}{UARTDMAEnable} (unsigned long ulBase, unsigned long ulDMAFlags)
\item 
void \hyperlink{group__uart__api_ga46f9d85ca9f6db5829fd244a4878b573}{UARTDMADisable} (unsigned long ulBase, unsigned long ulDMAFlags)
\item 
unsigned long \hyperlink{group__uart__api_ga652f288eae9bf0e0f588dd6d6c08ce99}{UARTRxErrorGet} (unsigned long ulBase)
\item 
void \hyperlink{group__uart__api_gac611cf8620e0f0876bdc1efbee47df96}{UARTRxErrorClear} (unsigned long ulBase)
\end{DoxyCompactItemize}


\subsection{Define Documentation}
\hypertarget{group__uart__api_ga3082604a4c1d62e98ac86f0f32cf34dd}{
\index{uart\_\-api@{uart\_\-api}!UART\_\-CLK\_\-DIVIDER@{UART\_\-CLK\_\-DIVIDER}}
\index{UART\_\-CLK\_\-DIVIDER@{UART\_\-CLK\_\-DIVIDER}!uart_api@{uart\_\-api}}
\subsubsection[{UART\_\-CLK\_\-DIVIDER}]{\setlength{\rightskip}{0pt plus 5cm}\#define UART\_\-CLK\_\-DIVIDER}}
\label{group__uart__api_ga3082604a4c1d62e98ac86f0f32cf34dd}
{\bfseries Value:}
\begin{DoxyCode}
((CLASS_IS_SANDSTORM ||                       \
                                  (CLASS_IS_FURY && REVISION_IS_A2) ||        \
                                  (CLASS_IS_DUSTDEVIL && REVISION_IS_A0)) ?   \
                                 16 : 8)
\end{DoxyCode}


\subsection{Function Documentation}
\hypertarget{group__uart__api_gacacb3f55eee1aa3b4f77359715014d3f}{
\index{uart\_\-api@{uart\_\-api}!UARTBreakCtl@{UARTBreakCtl}}
\index{UARTBreakCtl@{UARTBreakCtl}!uart_api@{uart\_\-api}}
\subsubsection[{UARTBreakCtl}]{\setlength{\rightskip}{0pt plus 5cm}void UARTBreakCtl (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{tBoolean}]{ bBreakState}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_gacacb3f55eee1aa3b4f77359715014d3f}
Causes a BREAK to be sent.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em bBreakState}]controls the output level.\end{DoxyParams}
Calling this function with {\itshape bBreakState\/} set to {\bfseries true} will assert a break condition on the UART. Calling this function with {\itshape bBreakState\/} set to {\bfseries false} will remove the break condition. For proper transmission of a break command, the break must be asserted for at least two complete frames.

\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_gafc7dd7a073f54c94d0edd353b6bea9e6}{
\index{uart\_\-api@{uart\_\-api}!UARTBusy@{UARTBusy}}
\index{UARTBusy@{UARTBusy}!uart_api@{uart\_\-api}}
\subsubsection[{UARTBusy}]{\setlength{\rightskip}{0pt plus 5cm}tBoolean UARTBusy (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_gafc7dd7a073f54c94d0edd353b6bea9e6}
Determines whether the UART transmitter is busy or not.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
Allows the caller to determine whether all transmitted bytes have cleared the transmitter hardware. If {\bfseries false} is returned, the transmit FIFO is empty and all bits of the last transmitted character, including all stop bits, have left the hardware shift register.

\begin{DoxyReturn}{Returns}
Returns {\bfseries true} if the UART is transmitting or {\bfseries false} if all transmissions are complete. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga1a69bc9d77f005406b49a3f7f12ae95c}{
\index{uart\_\-api@{uart\_\-api}!UARTCharGet@{UARTCharGet}}
\index{UARTCharGet@{UARTCharGet}!uart_api@{uart\_\-api}}
\subsubsection[{UARTCharGet}]{\setlength{\rightskip}{0pt plus 5cm}long UARTCharGet (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga1a69bc9d77f005406b49a3f7f12ae95c}
Waits for a character from the specified port.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
Gets a character from the receive FIFO for the specified port. If there are no characters available, this function will wait until a character is received before returning.

\begin{DoxyReturn}{Returns}
Returns the character read from the specified port, cast as an {\itshape long\/}. 
\end{DoxyReturn}
\hypertarget{group__uart__api_gabb43dee3bc04bf1b96a2937659c69240}{
\index{uart\_\-api@{uart\_\-api}!UARTCharGetNonBlocking@{UARTCharGetNonBlocking}}
\index{UARTCharGetNonBlocking@{UARTCharGetNonBlocking}!uart_api@{uart\_\-api}}
\subsubsection[{UARTCharGetNonBlocking}]{\setlength{\rightskip}{0pt plus 5cm}long UARTCharGetNonBlocking (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_gabb43dee3bc04bf1b96a2937659c69240}
Receives a character from the specified port.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
Gets a character from the receive FIFO for the specified port.

This function replaces the original UARTCharNonBlockingGet() API and performs the same actions. A macro is provided in {\ttfamily \hyperlink{uart_8h_source}{uart.h}} to map the original API to this API.

\begin{DoxyReturn}{Returns}
Returns the character read from the specified port, cast as a {\itshape long\/}. A {\bfseries -\/1} will be returned if there are no characters present in the receive FIFO. The \hyperlink{group__uart__api_ga7044fe20068144878fd2522e7e9a5906}{UARTCharsAvail()} function should be called before attempting to call this function. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga264bf4d7b309ecb7398a5b6a735e05a6}{
\index{uart\_\-api@{uart\_\-api}!UARTCharPut@{UARTCharPut}}
\index{UARTCharPut@{UARTCharPut}!uart_api@{uart\_\-api}}
\subsubsection[{UARTCharPut}]{\setlength{\rightskip}{0pt plus 5cm}void UARTCharPut (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{unsigned char}]{ ucData}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga264bf4d7b309ecb7398a5b6a735e05a6}
Waits to send a character from the specified port.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em ucData}]is the character to be transmitted.\end{DoxyParams}
Sends the character {\itshape ucData\/} to the transmit FIFO for the specified port. If there is no space available in the transmit FIFO, this function will wait until there is space available before returning.

\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_gaef2dd93e39148080c87880b8da14adc3}{
\index{uart\_\-api@{uart\_\-api}!UARTCharPutNonBlocking@{UARTCharPutNonBlocking}}
\index{UARTCharPutNonBlocking@{UARTCharPutNonBlocking}!uart_api@{uart\_\-api}}
\subsubsection[{UARTCharPutNonBlocking}]{\setlength{\rightskip}{0pt plus 5cm}tBoolean UARTCharPutNonBlocking (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{unsigned char}]{ ucData}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_gaef2dd93e39148080c87880b8da14adc3}
Sends a character to the specified port.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em ucData}]is the character to be transmitted.\end{DoxyParams}
Writes the character {\itshape ucData\/} to the transmit FIFO for the specified port. This function does not block, so if there is no space available, then a {\bfseries false} is returned, and the application will have to retry the function later.

This function replaces the original UARTCharNonBlockingPut() API and performs the same actions. A macro is provided in {\ttfamily \hyperlink{uart_8h_source}{uart.h}} to map the original API to this API.

\begin{DoxyReturn}{Returns}
Returns {\bfseries true} if the character was successfully placed in the transmit FIFO, and {\bfseries false} if there was no space available in the transmit FIFO. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga7044fe20068144878fd2522e7e9a5906}{
\index{uart\_\-api@{uart\_\-api}!UARTCharsAvail@{UARTCharsAvail}}
\index{UARTCharsAvail@{UARTCharsAvail}!uart_api@{uart\_\-api}}
\subsubsection[{UARTCharsAvail}]{\setlength{\rightskip}{0pt plus 5cm}tBoolean UARTCharsAvail (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga7044fe20068144878fd2522e7e9a5906}
Determines if there are any characters in the receive FIFO.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
This function returns a flag indicating whether or not there is data available in the receive FIFO.

\begin{DoxyReturn}{Returns}
Returns {\bfseries true} if there is data in the receive FIFO, and {\bfseries false} if there is no data in the receive FIFO. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga8a47d0131c5d06962e572e2c764343e5}{
\index{uart\_\-api@{uart\_\-api}!UARTConfigGetExpClk@{UARTConfigGetExpClk}}
\index{UARTConfigGetExpClk@{UARTConfigGetExpClk}!uart_api@{uart\_\-api}}
\subsubsection[{UARTConfigGetExpClk}]{\setlength{\rightskip}{0pt plus 5cm}void UARTConfigGetExpClk (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{unsigned long}]{ ulUARTClk, }
\item[{unsigned long $\ast$}]{ pulBaud, }
\item[{unsigned long $\ast$}]{ pulConfig}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga8a47d0131c5d06962e572e2c764343e5}
Gets the current configuration of a UART.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em ulUARTClk}]is the rate of the clock supplied to the UART module. \item[{\em pulBaud}]is a pointer to storage for the baud rate. \item[{\em pulConfig}]is a pointer to storage for the data format.\end{DoxyParams}
The baud rate and data format for the UART is determined, given an explicitly provided peripheral clock (hence the ExpClk suffix). The returned baud rate is the actual baud rate; it may not be the exact baud rate requested or an ``official'' baud rate. The data format returned in {\itshape pulConfig\/} is enumerated the same as the {\itshape ulConfig\/} parameter of \hyperlink{group__uart__api_ga174a10f735a7e11645e17c893b1f10a9}{UARTConfigSetExpClk()}.

The peripheral clock will be the same as the processor clock. This will be the value returned by \hyperlink{group__sysctl__api_ga7fd64f17ef7b589c51d72df5837f13eb}{SysCtlClockGet()}, or it can be explicitly hard coded if it is constant and known (to save the code/execution overhead of a call to \hyperlink{group__sysctl__api_ga7fd64f17ef7b589c51d72df5837f13eb}{SysCtlClockGet()}).

This function replaces the original UARTConfigGet() API and performs the same actions. A macro is provided in {\ttfamily \hyperlink{uart_8h_source}{uart.h}} to map the original API to this API.

\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga174a10f735a7e11645e17c893b1f10a9}{
\index{uart\_\-api@{uart\_\-api}!UARTConfigSetExpClk@{UARTConfigSetExpClk}}
\index{UARTConfigSetExpClk@{UARTConfigSetExpClk}!uart_api@{uart\_\-api}}
\subsubsection[{UARTConfigSetExpClk}]{\setlength{\rightskip}{0pt plus 5cm}void UARTConfigSetExpClk (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{unsigned long}]{ ulUARTClk, }
\item[{unsigned long}]{ ulBaud, }
\item[{unsigned long}]{ ulConfig}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga174a10f735a7e11645e17c893b1f10a9}
Sets the configuration of a UART.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em ulUARTClk}]is the rate of the clock supplied to the UART module. \item[{\em ulBaud}]is the desired baud rate. \item[{\em ulConfig}]is the data format for the port (number of data bits, number of stop bits, and parity).\end{DoxyParams}
This function will configure the UART for operation in the specified data format. The baud rate is provided in the {\itshape ulBaud\/} parameter and the data format in the {\itshape ulConfig\/} parameter.

The {\itshape ulConfig\/} parameter is the logical OR of three values: the number of data bits, the number of stop bits, and the parity. {\bfseries UART\_\-CONFIG\_\-WLEN\_\-8}, {\bfseries UART\_\-CONFIG\_\-WLEN\_\-7}, {\bfseries UART\_\-CONFIG\_\-WLEN\_\-6}, and {\bfseries UART\_\-CONFIG\_\-WLEN\_\-5} select from eight to five data bits per byte (respectively). {\bfseries UART\_\-CONFIG\_\-STOP\_\-ONE} and {\bfseries UART\_\-CONFIG\_\-STOP\_\-TWO} select one or two stop bits (respectively). {\bfseries UART\_\-CONFIG\_\-PAR\_\-NONE}, {\bfseries UART\_\-CONFIG\_\-PAR\_\-EVEN}, {\bfseries UART\_\-CONFIG\_\-PAR\_\-ODD}, {\bfseries UART\_\-CONFIG\_\-PAR\_\-ONE}, and {\bfseries UART\_\-CONFIG\_\-PAR\_\-ZERO} select the parity mode (no parity bit, even parity bit, odd parity bit, parity bit always one, and parity bit always zero, respectively).

The peripheral clock will be the same as the processor clock. This will be the value returned by \hyperlink{group__sysctl__api_ga7fd64f17ef7b589c51d72df5837f13eb}{SysCtlClockGet()}, or it can be explicitly hard coded if it is constant and known (to save the code/execution overhead of a call to \hyperlink{group__sysctl__api_ga7fd64f17ef7b589c51d72df5837f13eb}{SysCtlClockGet()}).

This function replaces the original UARTConfigSet() API and performs the same actions. A macro is provided in {\ttfamily \hyperlink{uart_8h_source}{uart.h}} to map the original API to this API.

\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_gaa0d8f81b2c9ef3e8a7fbc4f5128f3fb0}{
\index{uart\_\-api@{uart\_\-api}!UARTDisable@{UARTDisable}}
\index{UARTDisable@{UARTDisable}!uart_api@{uart\_\-api}}
\subsubsection[{UARTDisable}]{\setlength{\rightskip}{0pt plus 5cm}void UARTDisable (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_gaa0d8f81b2c9ef3e8a7fbc4f5128f3fb0}
Disables transmitting and receiving.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
Clears the UARTEN, TXE, and RXE bits, then waits for the end of transmission of the current character, and flushes the transmit FIFO.

\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_gab8c5b1ec5a1837d13961077c130ff111}{
\index{uart\_\-api@{uart\_\-api}!UARTDisableSIR@{UARTDisableSIR}}
\index{UARTDisableSIR@{UARTDisableSIR}!uart_api@{uart\_\-api}}
\subsubsection[{UARTDisableSIR}]{\setlength{\rightskip}{0pt plus 5cm}void UARTDisableSIR (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_gab8c5b1ec5a1837d13961077c130ff111}
Disables SIR (IrDA) mode on the specified UART.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
Clears the SIREN (IrDA) and SIRLP (Low Power) bits.

\begin{DoxyNote}{Note}
SIR (IrDA) operation is not supported on Sandstorm-\/class devices.
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga46f9d85ca9f6db5829fd244a4878b573}{
\index{uart\_\-api@{uart\_\-api}!UARTDMADisable@{UARTDMADisable}}
\index{UARTDMADisable@{UARTDMADisable}!uart_api@{uart\_\-api}}
\subsubsection[{UARTDMADisable}]{\setlength{\rightskip}{0pt plus 5cm}void UARTDMADisable (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{unsigned long}]{ ulDMAFlags}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga46f9d85ca9f6db5829fd244a4878b573}
Disable UART DMA operation.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em ulDMAFlags}]is a bit mask of the DMA features to disable.\end{DoxyParams}
This function is used to disable UART DMA features that were enabled by \hyperlink{group__uart__api_gabdbf6470ce1c96eaaa12ca41d58aabfb}{UARTDMAEnable()}. The specified UART DMA features are disabled. The {\itshape ulDMAFlags\/} parameter is the logical OR of any of the following values:


\begin{DoxyItemize}
\item UART\_\-DMA\_\-RX -\/ disable DMA for receive
\item UART\_\-DMA\_\-TX -\/ disable DMA for transmit
\item UART\_\-DMA\_\-ERR\_\-RXSTOP -\/ do not disable DMA receive on UART error
\end{DoxyItemize}

\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_gabdbf6470ce1c96eaaa12ca41d58aabfb}{
\index{uart\_\-api@{uart\_\-api}!UARTDMAEnable@{UARTDMAEnable}}
\index{UARTDMAEnable@{UARTDMAEnable}!uart_api@{uart\_\-api}}
\subsubsection[{UARTDMAEnable}]{\setlength{\rightskip}{0pt plus 5cm}void UARTDMAEnable (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{unsigned long}]{ ulDMAFlags}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_gabdbf6470ce1c96eaaa12ca41d58aabfb}
Enable UART DMA operation.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em ulDMAFlags}]is a bit mask of the DMA features to enable.\end{DoxyParams}
The specified UART DMA features are enabled. The UART can be configured to use DMA for transmit or receive, and to disable receive if an error occurs. The {\itshape ulDMAFlags\/} parameter is the logical OR of any of the following values:


\begin{DoxyItemize}
\item UART\_\-DMA\_\-RX -\/ enable DMA for receive
\item UART\_\-DMA\_\-TX -\/ enable DMA for transmit
\item UART\_\-DMA\_\-ERR\_\-RXSTOP -\/ disable DMA receive on UART error
\end{DoxyItemize}

\begin{DoxyNote}{Note}
The uDMA controller must also be set up before DMA can be used with the UART.
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_gacc1104922d17e36b8e54fc10234f450a}{
\index{uart\_\-api@{uart\_\-api}!UARTEnable@{UARTEnable}}
\index{UARTEnable@{UARTEnable}!uart_api@{uart\_\-api}}
\subsubsection[{UARTEnable}]{\setlength{\rightskip}{0pt plus 5cm}void UARTEnable (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_gacc1104922d17e36b8e54fc10234f450a}
Enables transmitting and receiving.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
Sets the UARTEN, TXE, and RXE bits, and enables the transmit and receive FIFOs.

\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga11b801327a12971dd45ee4a9f4d63a48}{
\index{uart\_\-api@{uart\_\-api}!UARTEnableSIR@{UARTEnableSIR}}
\index{UARTEnableSIR@{UARTEnableSIR}!uart_api@{uart\_\-api}}
\subsubsection[{UARTEnableSIR}]{\setlength{\rightskip}{0pt plus 5cm}void UARTEnableSIR (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{tBoolean}]{ bLowPower}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga11b801327a12971dd45ee4a9f4d63a48}
Enables SIR (IrDA) mode on the specified UART.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em bLowPower}]indicates if SIR Low Power Mode is to be used.\end{DoxyParams}
Enables the SIREN control bit for IrDA mode on the UART. If the {\itshape bLowPower\/} flag is set, then SIRLP bit will also be set.

\begin{DoxyNote}{Note}
SIR (IrDA) operation is not supported on Sandstorm-\/class devices.
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga43f0540451cd15a76249580db4e8c49a}{
\index{uart\_\-api@{uart\_\-api}!UARTFIFODisable@{UARTFIFODisable}}
\index{UARTFIFODisable@{UARTFIFODisable}!uart_api@{uart\_\-api}}
\subsubsection[{UARTFIFODisable}]{\setlength{\rightskip}{0pt plus 5cm}void UARTFIFODisable (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga43f0540451cd15a76249580db4e8c49a}
Disables the transmit and receive FIFOs.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
This functions disables the transmit and receive FIFOs in the UART.

\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga7ff285fcffe190e94580ed2c3d88d453}{
\index{uart\_\-api@{uart\_\-api}!UARTFIFOEnable@{UARTFIFOEnable}}
\index{UARTFIFOEnable@{UARTFIFOEnable}!uart_api@{uart\_\-api}}
\subsubsection[{UARTFIFOEnable}]{\setlength{\rightskip}{0pt plus 5cm}void UARTFIFOEnable (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga7ff285fcffe190e94580ed2c3d88d453}
Enables the transmit and receive FIFOs.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
This functions enables the transmit and receive FIFOs in the UART.

\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga30e3f5cfeb0006b664a7af4a91c41713}{
\index{uart\_\-api@{uart\_\-api}!UARTFIFOLevelGet@{UARTFIFOLevelGet}}
\index{UARTFIFOLevelGet@{UARTFIFOLevelGet}!uart_api@{uart\_\-api}}
\subsubsection[{UARTFIFOLevelGet}]{\setlength{\rightskip}{0pt plus 5cm}void UARTFIFOLevelGet (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{unsigned long $\ast$}]{ pulTxLevel, }
\item[{unsigned long $\ast$}]{ pulRxLevel}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga30e3f5cfeb0006b664a7af4a91c41713}
Gets the FIFO level at which interrupts are generated.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em pulTxLevel}]is a pointer to storage for the transmit FIFO level, returned as one of {\bfseries UART\_\-FIFO\_\-TX1\_\-8}, {\bfseries UART\_\-FIFO\_\-TX2\_\-8}, {\bfseries UART\_\-FIFO\_\-TX4\_\-8}, {\bfseries UART\_\-FIFO\_\-TX6\_\-8}, or UART\_\-FIFO\_\-TX7\_\-8. \item[{\em pulRxLevel}]is a pointer to storage for the receive FIFO level, returned as one of {\bfseries UART\_\-FIFO\_\-RX1\_\-8}, {\bfseries UART\_\-FIFO\_\-RX2\_\-8}, {\bfseries UART\_\-FIFO\_\-RX4\_\-8}, {\bfseries UART\_\-FIFO\_\-RX6\_\-8}, or {\bfseries UART\_\-FIFO\_\-RX7\_\-8}.\end{DoxyParams}
This function gets the FIFO level at which transmit and receive interrupts will be generated.

\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga03ac261faad90a93a6a728b450412814}{
\index{uart\_\-api@{uart\_\-api}!UARTFIFOLevelSet@{UARTFIFOLevelSet}}
\index{UARTFIFOLevelSet@{UARTFIFOLevelSet}!uart_api@{uart\_\-api}}
\subsubsection[{UARTFIFOLevelSet}]{\setlength{\rightskip}{0pt plus 5cm}void UARTFIFOLevelSet (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{unsigned long}]{ ulTxLevel, }
\item[{unsigned long}]{ ulRxLevel}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga03ac261faad90a93a6a728b450412814}
Sets the FIFO level at which interrupts are generated.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em ulTxLevel}]is the transmit FIFO interrupt level, specified as one of {\bfseries UART\_\-FIFO\_\-TX1\_\-8}, {\bfseries UART\_\-FIFO\_\-TX2\_\-8}, {\bfseries UART\_\-FIFO\_\-TX4\_\-8}, {\bfseries UART\_\-FIFO\_\-TX6\_\-8}, or {\bfseries UART\_\-FIFO\_\-TX7\_\-8}. \item[{\em ulRxLevel}]is the receive FIFO interrupt level, specified as one of {\bfseries UART\_\-FIFO\_\-RX1\_\-8}, {\bfseries UART\_\-FIFO\_\-RX2\_\-8}, {\bfseries UART\_\-FIFO\_\-RX4\_\-8}, {\bfseries UART\_\-FIFO\_\-RX6\_\-8}, or {\bfseries UART\_\-FIFO\_\-RX7\_\-8}.\end{DoxyParams}
This function sets the FIFO level at which transmit and receive interrupts will be generated.

\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga206a270d0b9b7eb0e73bf054959e0d97}{
\index{uart\_\-api@{uart\_\-api}!UARTFlowControlGet@{UARTFlowControlGet}}
\index{UARTFlowControlGet@{UARTFlowControlGet}!uart_api@{uart\_\-api}}
\subsubsection[{UARTFlowControlGet}]{\setlength{\rightskip}{0pt plus 5cm}unsigned long UARTFlowControlGet (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga206a270d0b9b7eb0e73bf054959e0d97}
Returns the UART hardware flow control mode currently in use.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
Returns the current hardware flow control mode.

\begin{DoxyNote}{Note}
The availability of hardware flow control varies with the Stellaris part and UART in use. Please consult the datasheet for the part you are using to determine whether this support is available.
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
Returns the current flow control mode in use. This is a logical OR combination of values {\bfseries UART\_\-FLOWCONTROL\_\-TX} if transmit (CTS) flow control is enabled and {\bfseries UART\_\-FLOWCONTROL\_\-RX} if receive (RTS) flow control is in use. If hardware flow control is disabled, {\bfseries UART\_\-FLOWCONTROL\_\-NONE} will be returned. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga6eeabcb27e83ab4c37df473bdfd4c9ea}{
\index{uart\_\-api@{uart\_\-api}!UARTFlowControlSet@{UARTFlowControlSet}}
\index{UARTFlowControlSet@{UARTFlowControlSet}!uart_api@{uart\_\-api}}
\subsubsection[{UARTFlowControlSet}]{\setlength{\rightskip}{0pt plus 5cm}void UARTFlowControlSet (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{unsigned long}]{ ulMode}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga6eeabcb27e83ab4c37df473bdfd4c9ea}
Sets the UART hardware flow control mode to be used.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em ulMode}]indicates the flow control modes to be used. This is a logical OR combination of values {\bfseries UART\_\-FLOWCONTROL\_\-TX} and {\bfseries UART\_\-FLOWCONTROL\_\-RX} to enable hardware transmit (CTS) and receive (RTS) flow control or {\bfseries UART\_\-FLOWCONTROL\_\-NONE} to disable hardware flow control.\end{DoxyParams}
Sets the required hardware flow control modes. If {\itshape ulMode\/} contains flag {\bfseries UART\_\-FLOWCONTROL\_\-TX}, data is only transmitted if the incoming CTS signal is asserted. If {\itshape ulMode\/} contains flag {\bfseries UART\_\-FLOWCONTROL\_\-RX}, the RTS output is controlled by the hardware and is asserted only when there is space available in the receive FIFO. If no hardware flow control is required, UART\_\-FLOWCONTROL\_\-NONE should be passed.

\begin{DoxyNote}{Note}
The availability of hardware flow control varies with the Stellaris part and UART in use. Please consult the datasheet for the part you are using to determine whether this support is available.
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga8fa3c50d42d232749f3574e099f7031b}{
\index{uart\_\-api@{uart\_\-api}!UARTIntClear@{UARTIntClear}}
\index{UARTIntClear@{UARTIntClear}!uart_api@{uart\_\-api}}
\subsubsection[{UARTIntClear}]{\setlength{\rightskip}{0pt plus 5cm}void UARTIntClear (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{unsigned long}]{ ulIntFlags}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga8fa3c50d42d232749f3574e099f7031b}
Clears UART interrupt sources.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em ulIntFlags}]is a bit mask of the interrupt sources to be cleared.\end{DoxyParams}
The specified UART interrupt sources are cleared, so that they no longer assert. This must be done in the interrupt handler to keep it from being called again immediately upon exit.

The {\itshape ulIntFlags\/} parameter has the same definition as the {\itshape ulIntFlags\/} parameter to \hyperlink{group__uart__api_gae2e0dbcdb433d714f45934c531d38a2a}{UARTIntEnable()}.

\begin{DoxyNote}{Note}
Since there is a write buffer in the Cortex-\/M3 processor, it may take several clock cycles before the interrupt source is actually cleared. Therefore, it is recommended that the interrupt source be cleared early in the interrupt handler (as opposed to the very last action) to avoid returning from the interrupt handler before the interrupt source is actually cleared. Failure to do so may result in the interrupt handler being immediately reentered (since NVIC still sees the interrupt source asserted).
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga9b5e85acf8ff0ce74bf8b43686c306a8}{
\index{uart\_\-api@{uart\_\-api}!UARTIntDisable@{UARTIntDisable}}
\index{UARTIntDisable@{UARTIntDisable}!uart_api@{uart\_\-api}}
\subsubsection[{UARTIntDisable}]{\setlength{\rightskip}{0pt plus 5cm}void UARTIntDisable (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{unsigned long}]{ ulIntFlags}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga9b5e85acf8ff0ce74bf8b43686c306a8}
Disables individual UART interrupt sources.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em ulIntFlags}]is the bit mask of the interrupt sources to be disabled.\end{DoxyParams}
Disables the indicated UART interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt; disabled sources have no effect on the processor.

The {\itshape ulIntFlags\/} parameter has the same definition as the {\itshape ulIntFlags\/} parameter to \hyperlink{group__uart__api_gae2e0dbcdb433d714f45934c531d38a2a}{UARTIntEnable()}.

\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_gae2e0dbcdb433d714f45934c531d38a2a}{
\index{uart\_\-api@{uart\_\-api}!UARTIntEnable@{UARTIntEnable}}
\index{UARTIntEnable@{UARTIntEnable}!uart_api@{uart\_\-api}}
\subsubsection[{UARTIntEnable}]{\setlength{\rightskip}{0pt plus 5cm}void UARTIntEnable (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{unsigned long}]{ ulIntFlags}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_gae2e0dbcdb433d714f45934c531d38a2a}
Enables individual UART interrupt sources.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em ulIntFlags}]is the bit mask of the interrupt sources to be enabled.\end{DoxyParams}
Enables the indicated UART interrupt sources. Only the sources that are enabled can be reflected to the processor interrupt; disabled sources have no effect on the processor.

The {\itshape ulIntFlags\/} parameter is the logical OR of any of the following:


\begin{DoxyItemize}
\item {\bfseries UART\_\-INT\_\-OE} -\/ Overrun Error interrupt
\item {\bfseries UART\_\-INT\_\-BE} -\/ Break Error interrupt
\item {\bfseries UART\_\-INT\_\-PE} -\/ Parity Error interrupt
\item {\bfseries UART\_\-INT\_\-FE} -\/ Framing Error interrupt
\item {\bfseries UART\_\-INT\_\-RT} -\/ Receive Timeout interrupt
\item {\bfseries UART\_\-INT\_\-TX} -\/ Transmit interrupt
\item {\bfseries UART\_\-INT\_\-RX} -\/ Receive interrupt
\item {\bfseries UART\_\-INT\_\-DSR} -\/ DSR interrupt
\item {\bfseries UART\_\-INT\_\-DCD} -\/ DCD interrupt
\item {\bfseries UART\_\-INT\_\-CTS} -\/ CTS interrupt
\item {\bfseries UART\_\-INT\_\-RI} -\/ RI interrupt
\end{DoxyItemize}

\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga3b0a30072c49b1414d6c0a8295e29d00}{
\index{uart\_\-api@{uart\_\-api}!UARTIntRegister@{UARTIntRegister}}
\index{UARTIntRegister@{UARTIntRegister}!uart_api@{uart\_\-api}}
\subsubsection[{UARTIntRegister}]{\setlength{\rightskip}{0pt plus 5cm}void UARTIntRegister (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{void($\ast$)(void)}]{ pfnHandler}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga3b0a30072c49b1414d6c0a8295e29d00}
Registers an interrupt handler for a UART interrupt.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em pfnHandler}]is a pointer to the function to be called when the UART interrupt occurs.\end{DoxyParams}
This function does the actual registering of the interrupt handler. This will enable the global interrupt in the interrupt controller; specific UART interrupts must be enabled via \hyperlink{group__uart__api_gae2e0dbcdb433d714f45934c531d38a2a}{UARTIntEnable()}. It is the interrupt handler's responsibility to clear the interrupt source.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__interrupt__api_ga471d00d73ae22faa426c202f608e9c69}{IntRegister()} for important information about registering interrupt handlers.
\end{DoxySeeAlso}
\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga7c827b68812b2ced7f127dcd8129d955}{
\index{uart\_\-api@{uart\_\-api}!UARTIntStatus@{UARTIntStatus}}
\index{UARTIntStatus@{UARTIntStatus}!uart_api@{uart\_\-api}}
\subsubsection[{UARTIntStatus}]{\setlength{\rightskip}{0pt plus 5cm}unsigned long UARTIntStatus (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{tBoolean}]{ bMasked}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga7c827b68812b2ced7f127dcd8129d955}
Gets the current interrupt status.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em bMasked}]is false if the raw interrupt status is required and true if the masked interrupt status is required.\end{DoxyParams}
This returns the interrupt status for the specified UART. Either the raw interrupt status or the status of interrupts that are allowed to reflect to the processor can be returned.

\begin{DoxyReturn}{Returns}
Returns the current interrupt status, enumerated as a bit field of values described in \hyperlink{group__uart__api_gae2e0dbcdb433d714f45934c531d38a2a}{UARTIntEnable()}. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga73bc2d5b32b3bfb4eb0987b55efaaf45}{
\index{uart\_\-api@{uart\_\-api}!UARTIntUnregister@{UARTIntUnregister}}
\index{UARTIntUnregister@{UARTIntUnregister}!uart_api@{uart\_\-api}}
\subsubsection[{UARTIntUnregister}]{\setlength{\rightskip}{0pt plus 5cm}void UARTIntUnregister (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga73bc2d5b32b3bfb4eb0987b55efaaf45}
Unregisters an interrupt handler for a UART interrupt.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
This function does the actual unregistering of the interrupt handler. It will clear the handler to be called when a UART interrupt occurs. This will also mask off the interrupt in the interrupt controller so that the interrupt handler no longer is called.

\begin{DoxySeeAlso}{See also}
\hyperlink{group__interrupt__api_ga471d00d73ae22faa426c202f608e9c69}{IntRegister()} for important information about registering interrupt handlers.
\end{DoxySeeAlso}
\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga18a48c2588dc18c185d2bfe56efa38a4}{
\index{uart\_\-api@{uart\_\-api}!UARTModemControlClear@{UARTModemControlClear}}
\index{UARTModemControlClear@{UARTModemControlClear}!uart_api@{uart\_\-api}}
\subsubsection[{UARTModemControlClear}]{\setlength{\rightskip}{0pt plus 5cm}void UARTModemControlClear (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{unsigned long}]{ ulControl}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga18a48c2588dc18c185d2bfe56efa38a4}
Clears the states of the DTR and/or RTS modem control signals.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em ulControl}]is a bit-\/mapped flag indicating which modem control bits should be set.\end{DoxyParams}
Clears the states of the DTR or RTS modem handshake outputs from the UART.

The {\itshape ulControl\/} parameter is the logical OR of any of the following:


\begin{DoxyItemize}
\item {\bfseries UART\_\-OUTPUT\_\-DTR} -\/ The Modem Control DTR signal
\item {\bfseries UART\_\-OUTPUT\_\-RTS} -\/ The Modem Control RTS signal
\end{DoxyItemize}

\begin{DoxyNote}{Note}
The availability of hardware modem handshake signals varies with the Stellaris part and UART in use. Please consult the datasheet for the part you are using to determine whether this support is available.
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_gaf0fc13d9eb0862f6550fee0d80b7c928}{
\index{uart\_\-api@{uart\_\-api}!UARTModemControlGet@{UARTModemControlGet}}
\index{UARTModemControlGet@{UARTModemControlGet}!uart_api@{uart\_\-api}}
\subsubsection[{UARTModemControlGet}]{\setlength{\rightskip}{0pt plus 5cm}unsigned long UARTModemControlGet (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_gaf0fc13d9eb0862f6550fee0d80b7c928}
Gets the states of the DTR and RTS modem control signals.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
Returns the current states of each of the two UART modem control signals, DTR and RTS.

\begin{DoxyNote}{Note}
The availability of hardware modem handshake signals varies with the Stellaris part and UART in use. Please consult the datasheet for the part you are using to determine whether this support is available.
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
Returns the states of the handshake output signals. This will be a logical logical OR combination of values {\bfseries UART\_\-OUTPUT\_\-RTS} and {\bfseries UART\_\-OUTPUT\_\-DTR} where the presence of each flag indicates that the associated signal is asserted. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga11748f2c339c4ac76081dc4579ce48fb}{
\index{uart\_\-api@{uart\_\-api}!UARTModemControlSet@{UARTModemControlSet}}
\index{UARTModemControlSet@{UARTModemControlSet}!uart_api@{uart\_\-api}}
\subsubsection[{UARTModemControlSet}]{\setlength{\rightskip}{0pt plus 5cm}void UARTModemControlSet (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{unsigned long}]{ ulControl}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga11748f2c339c4ac76081dc4579ce48fb}
Sets the states of the DTR and/or RTS modem control signals.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em ulControl}]is a bit-\/mapped flag indicating which modem control bits should be set.\end{DoxyParams}
Sets the states of the DTR or RTS modem handshake outputs from the UART.

The {\itshape ulControl\/} parameter is the logical OR of any of the following:


\begin{DoxyItemize}
\item {\bfseries UART\_\-OUTPUT\_\-DTR} -\/ The Modem Control DTR signal
\item {\bfseries UART\_\-OUTPUT\_\-RTS} -\/ The Modem Control RTS signal
\end{DoxyItemize}

\begin{DoxyNote}{Note}
The availability of hardware modem handshake signals varies with the Stellaris part and UART in use. Please consult the datasheet for the part you are using to determine whether this support is available.
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga65e88c92f875fe09497649b0b64ed38b}{
\index{uart\_\-api@{uart\_\-api}!UARTModemStatusGet@{UARTModemStatusGet}}
\index{UARTModemStatusGet@{UARTModemStatusGet}!uart_api@{uart\_\-api}}
\subsubsection[{UARTModemStatusGet}]{\setlength{\rightskip}{0pt plus 5cm}unsigned long UARTModemStatusGet (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga65e88c92f875fe09497649b0b64ed38b}
Gets the states of the RI, DCD, DSR and CTS modem status signals.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
Returns the current states of each of the four UART modem status signals, RI, DCD, DSR and CTS.

\begin{DoxyNote}{Note}
The availability of hardware modem handshake signals varies with the Stellaris part and UART in use. Please consult the datasheet for the part you are using to determine whether this support is available.
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
Returns the states of the handshake output signals. This will be a logical logical OR combination of values {\bfseries UART\_\-INPUT\_\-RI}, {\bfseries UART\_\-INPUT\_\-DCD}, {\bfseries UART\_\-INPUT\_\-CTS} and {\bfseries UART\_\-INPUT\_\-DSR} where the presence of each flag indicates that the associated signal is asserted. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga3d14f283b4007a333509e3748537709f}{
\index{uart\_\-api@{uart\_\-api}!UARTParityModeGet@{UARTParityModeGet}}
\index{UARTParityModeGet@{UARTParityModeGet}!uart_api@{uart\_\-api}}
\subsubsection[{UARTParityModeGet}]{\setlength{\rightskip}{0pt plus 5cm}unsigned long UARTParityModeGet (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga3d14f283b4007a333509e3748537709f}
Gets the type of parity currently being used.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
This function gets the type of parity used for transmitting data, and expected when receiving data.

\begin{DoxyReturn}{Returns}
Returns the current parity settings, specified as one of {\bfseries UART\_\-CONFIG\_\-PAR\_\-NONE}, {\bfseries UART\_\-CONFIG\_\-PAR\_\-EVEN}, {\bfseries UART\_\-CONFIG\_\-PAR\_\-ODD}, {\bfseries UART\_\-CONFIG\_\-PAR\_\-ONE}, or {\bfseries UART\_\-CONFIG\_\-PAR\_\-ZERO}. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga60b51a3d202057e4d131fadb9659d467}{
\index{uart\_\-api@{uart\_\-api}!UARTParityModeSet@{UARTParityModeSet}}
\index{UARTParityModeSet@{UARTParityModeSet}!uart_api@{uart\_\-api}}
\subsubsection[{UARTParityModeSet}]{\setlength{\rightskip}{0pt plus 5cm}void UARTParityModeSet (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{unsigned long}]{ ulParity}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga60b51a3d202057e4d131fadb9659d467}
Sets the type of parity.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em ulParity}]specifies the type of parity to use.\end{DoxyParams}
Sets the type of parity to use for transmitting and expect when receiving. The {\itshape ulParity\/} parameter must be one of {\bfseries UART\_\-CONFIG\_\-PAR\_\-NONE}, {\bfseries UART\_\-CONFIG\_\-PAR\_\-EVEN}, {\bfseries UART\_\-CONFIG\_\-PAR\_\-ODD}, {\bfseries UART\_\-CONFIG\_\-PAR\_\-ONE}, or {\bfseries UART\_\-CONFIG\_\-PAR\_\-ZERO}. The last two allow direct control of the parity bit; it will always be either be one or zero based on the mode.

\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_gac611cf8620e0f0876bdc1efbee47df96}{
\index{uart\_\-api@{uart\_\-api}!UARTRxErrorClear@{UARTRxErrorClear}}
\index{UARTRxErrorClear@{UARTRxErrorClear}!uart_api@{uart\_\-api}}
\subsubsection[{UARTRxErrorClear}]{\setlength{\rightskip}{0pt plus 5cm}void UARTRxErrorClear (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_gac611cf8620e0f0876bdc1efbee47df96}
Clears all reported receiver errors.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
This function is used to clear all receiver error conditions reported via \hyperlink{group__uart__api_ga652f288eae9bf0e0f588dd6d6c08ce99}{UARTRxErrorGet()}. If using the overrun, framing error, parity error or break interrupts, this function must be called after clearing the interrupt to ensure that later errors of the same type trigger another interrupt.

\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga652f288eae9bf0e0f588dd6d6c08ce99}{
\index{uart\_\-api@{uart\_\-api}!UARTRxErrorGet@{UARTRxErrorGet}}
\index{UARTRxErrorGet@{UARTRxErrorGet}!uart_api@{uart\_\-api}}
\subsubsection[{UARTRxErrorGet}]{\setlength{\rightskip}{0pt plus 5cm}unsigned long UARTRxErrorGet (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga652f288eae9bf0e0f588dd6d6c08ce99}
Gets current receiver errors.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
This function returns the current state of each of the 4 receiver error sources. The returned errors are equivalent to the four error bits returned via the previous call to \hyperlink{group__uart__api_ga1a69bc9d77f005406b49a3f7f12ae95c}{UARTCharGet()} or \hyperlink{group__uart__api_gabb43dee3bc04bf1b96a2937659c69240}{UARTCharGetNonBlocking()} with the exception that the overrun error is set immediately the overrun occurs rather than when a character is next read.

\begin{DoxyReturn}{Returns}
Returns a logical OR combination of the receiver error flags, {\bfseries UART\_\-RXERROR\_\-FRAMING}, {\bfseries UART\_\-RXERROR\_\-PARITY}, {\bfseries UART\_\-RXERROR\_\-BREAK} and {\bfseries UART\_\-RXERROR\_\-OVERRUN}. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga8f25858c44bfe9110a4e41f9cc645cd5}{
\index{uart\_\-api@{uart\_\-api}!UARTSmartCardDisable@{UARTSmartCardDisable}}
\index{UARTSmartCardDisable@{UARTSmartCardDisable}!uart_api@{uart\_\-api}}
\subsubsection[{UARTSmartCardDisable}]{\setlength{\rightskip}{0pt plus 5cm}void UARTSmartCardDisable (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga8f25858c44bfe9110a4e41f9cc645cd5}
Disables ISO 7816 smart card mode on the specified UART.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
Clears the SMART (ISO 7816 smart card) bits in the UART control register.

\begin{DoxyNote}{Note}
The availability of ISO 7816 smart card mode varies with the Stellaris part and UART in use. Please consult the datasheet for the part you are using to determine whether this support is available.
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga6da68929f43a33de8cdf3f3292659256}{
\index{uart\_\-api@{uart\_\-api}!UARTSmartCardEnable@{UARTSmartCardEnable}}
\index{UARTSmartCardEnable@{UARTSmartCardEnable}!uart_api@{uart\_\-api}}
\subsubsection[{UARTSmartCardEnable}]{\setlength{\rightskip}{0pt plus 5cm}void UARTSmartCardEnable (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga6da68929f43a33de8cdf3f3292659256}
Enables ISO 7816 smart card mode on the specified UART.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
Enables the SMART control bit for ISO 7816 smart card mode on the UART. This call also sets 8 bit word length and even parity as required by ISO 7816.

\begin{DoxyNote}{Note}
The availability of ISO 7816 smart card mode varies with the Stellaris part and UART in use. Please consult the datasheet for the part you are using to determine whether this support is available.
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
\hypertarget{group__uart__api_gaa08e306b9a49f638038d968392ff0cc1}{
\index{uart\_\-api@{uart\_\-api}!UARTSpaceAvail@{UARTSpaceAvail}}
\index{UARTSpaceAvail@{UARTSpaceAvail}!uart_api@{uart\_\-api}}
\subsubsection[{UARTSpaceAvail}]{\setlength{\rightskip}{0pt plus 5cm}tBoolean UARTSpaceAvail (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_gaa08e306b9a49f638038d968392ff0cc1}
Determines if there is any space in the transmit FIFO.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
This function returns a flag indicating whether or not there is space available in the transmit FIFO.

\begin{DoxyReturn}{Returns}
Returns {\bfseries true} if there is space available in the transmit FIFO, and {\bfseries false} if there is no space available in the transmit FIFO. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga76dd86207a90f186fe78684db444a6cf}{
\index{uart\_\-api@{uart\_\-api}!UARTTxIntModeGet@{UARTTxIntModeGet}}
\index{UARTTxIntModeGet@{UARTTxIntModeGet}!uart_api@{uart\_\-api}}
\subsubsection[{UARTTxIntModeGet}]{\setlength{\rightskip}{0pt plus 5cm}unsigned long UARTTxIntModeGet (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga76dd86207a90f186fe78684db444a6cf}
Returns the current operating mode for the UART transmit interrupt.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port.\end{DoxyParams}
This function returns the current operating mode for the UART transmit interrupt. The return value will be {\bfseries UART\_\-TXINT\_\-MODE\_\-EOT} if the transmit interrupt is currently set to be asserted once the transmitter is completely idle -\/ the transmit FIFO is empty and all bits, including any stop bits, have cleared the transmitter. The return value will be {\bfseries UART\_\-TXINT\_\-MODE\_\-FIFO} if the interrupt is set to be asserted based upon the level of the transmit FIFO.

\begin{DoxyNote}{Note}
The availability of end-\/of-\/transmission mode varies with the Stellaris part in use. Please consult the datasheet for the part you are using to determine whether this support is available.
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
Returns {\bfseries UART\_\-TXINT\_\-MODE\_\-FIFO} or {\bfseries UART\_\-TXINT\_\-MODE\_\-EOT}. 
\end{DoxyReturn}
\hypertarget{group__uart__api_ga12d6d0b529011cd29edd0142f90108e7}{
\index{uart\_\-api@{uart\_\-api}!UARTTxIntModeSet@{UARTTxIntModeSet}}
\index{UARTTxIntModeSet@{UARTTxIntModeSet}!uart_api@{uart\_\-api}}
\subsubsection[{UARTTxIntModeSet}]{\setlength{\rightskip}{0pt plus 5cm}void UARTTxIntModeSet (
\begin{DoxyParamCaption}
\item[{unsigned long}]{ ulBase, }
\item[{unsigned long}]{ ulMode}
\end{DoxyParamCaption}
)}}
\label{group__uart__api_ga12d6d0b529011cd29edd0142f90108e7}
Sets the operating mode for the UART transmit interrupt.


\begin{DoxyParams}{Parameters}
\item[{\em ulBase}]is the base address of the UART port. \item[{\em ulMode}]is the operating mode for the transmit interrupt. It may be {\bfseries UART\_\-TXINT\_\-MODE\_\-EOT} to trigger interrupts when the transmitter is idle or {\bfseries UART\_\-TXINT\_\-MODE\_\-FIFO} to trigger based on the current transmit FIFO level.\end{DoxyParams}
This function allows the mode of the UART transmit interrupt to be set. By default, the transmit interrupt is asserted when the FIFO level falls past a threshold set via a call to \hyperlink{group__uart__api_ga03ac261faad90a93a6a728b450412814}{UARTFIFOLevelSet()}. Alternatively, if this function is called with {\itshape ulMode\/} set to {\bfseries UART\_\-TXINT\_\-MODE\_\-EOT}, the transmit interrupt will only be asserted once the transmitter is completely idle -\/ the transmit FIFO is empty and all bits, including any stop bits, have cleared the transmitter.

\begin{DoxyNote}{Note}
The availability of end-\/of-\/transmission mode varies with the Stellaris part in use. Please consult the datasheet for the part you are using to determine whether this support is available.
\end{DoxyNote}
\begin{DoxyReturn}{Returns}
None. 
\end{DoxyReturn}
